Список заказов клиента

Запрос позволяет получить список заказов клиента.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/orders/list?
limit=<количество записей>
&offset=<количество пропускаемых записей>
&sorting_field={due_date|finished_date}
&sorting_direction={1|-1}
&since_datetime=<начальная_дата>
&till_datetime=<конечная_дата>

Заголовки запроса

Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.

X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос может содержать следующие необязательные параметры:

limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.
offset — количество пропускаемых записей. При отсутствии данного параметра возвращается информация начиная с первой записи.
sorting_field — поле, по которому сортируется возвращаемый список заказов. Может принимать значения: due_date - по дате начала заказа (значение по умолчанию), finished_date - по дате окончания заказа.
sorting_direction — направление сортировки возвращаемого списка заказов. Может принимать значения: 1 - по возрастанию, -1 - по убыванию (значение по умолчанию).
since_datetime — Начальное время для фильтрации. Формат значений: YYYY-MM-DDThh:mm:ss±hh:mm.
till_datetime — Конечное время для фильтрации. Формат значений: YYYY-MM-DDThh:mm:ss±hh:mm.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле	Описание	Формат
`items`	Список заказов клиента.	Массив объектов
`limit`	Максимальное количество возвращаемых записей.	Число
`offset`	Количество пропускаемых записей.	Число
`total_amount`	Количество возвращаемых записей.	Число

Структура элемента массива items:

Поле	Описание	Формат
`id`	Идентификатор заказа.	Строка
`user_id`	Идентификатор пользователя.	Строка
`class`	Наименование тарифа.	Строка
`status`	Статус заказа.	Строка
`source`	Начальная точка маршрута.	Объект
`interim_destinations`	Промежуточные точки маршрута.	Объект
`destination`	Конечная точка маршрута.	Объект
`cost_center_values`	Новые поля центра затрат.	Массив объектов
`due_date`	Время начала заказа. Формат значения: `YYYY-MM-DDThh:mm:ss±hh:mm`	Строка
`finished_date`	Время окончания заказа. Возвращается только для завершенного заказа. Формат значения: `YYYY-MM-DDThh:mm:ss±hh:mm`	Строка
`cost`	Стоимость без НДС. Возвращается только для завершенного заказа.	Число
`cost_with_vat`	Стоимость с НДС. Возвращается только для завершенного заказа.	Число

Структура объекта source-destination:

Поле	Описание	Формат
`geopoint`	Массив из двух значений, задающих долготу и широту точки.	Массив
`fullname`	Название точки.	Строка

Структура элемента массива cost_center_values:

Поле	Описание	Формат
`id`	id поля центра затрат.	Строка
`title`	Название поля центра затрат.	Строка
`value`	Новое значение поля.	Строка

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/orders/list?limit=5&offset=0&sorting_field=due_date&sorting_direction=1
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "items": [
    {
      "id": "507...1db",
      "user_id": "035...c71",
      "status": "cancelled",
      "class": "business",
      "source": {
        "fullname": "Москва, улица Новая Башиловка, 10",
        "geopoint": [
          37.56997813720699,
          55.78798846490584
        ]
      },
      "destination": {
        "fullname": "Москва, Садовая-Кудринская улица, 15с9",
        "geopoint": [
          37.58542766113278,
          55.76496146265227
        ]
      },
      "cost_center_values": [
        {
          "id": "cost_center",
          "title": "Цель поездки",
          "value": ""
        }
      ],
      "due_date": "2023-02-08T10:54:41+03:00",
      "finished_date": "2023-02-08T10:51:37.759000+03:00",
      "cost": 0,
      "cost_with_vat": 0
    },
    {
      "id": "b99...dc17",
      "user_id": "035...c71",
      "status": "complete",
      "class": "business",
      "source": {
        "fullname": "Москва, Большая Садовая улица, 14с9",
        "geopoint": [
          37.59538402099606,
          55.76728413277445
        ]
      },
      "destination": {
        "fullname": "Москва, Коробейников переулок, 1",
        "geopoint": [
          37.5998472167968,
          55.73785337560665
        ]
      },
      "cost_center_values": [
        {
          "id": "9af...12a",
          "title": "Цель поездки",
          "value": "по работе"
        }
      ],
      "due_date": "2023-02-08T17:50:36+03:00",
      "finished_date": "2023-02-08T17:56:17.442000+03:00",
      "cost": 345,
      "cost_with_vat": 414
    }
  ],
  "limit": 5,
  "offset": 0,
  "total_amount": 2
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
403:
- SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
- SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.

Была ли статья полезна?

Список активных заказов

Информация о заказе